Interface symantec.itools.awt.WizardInterface
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface symantec.itools.awt.WizardInterface

public interface WizardInterface
The Wizard API. A Wizard is a dialog that leads the user through a series of steps in order to accomplish some task.

See Also:
Wizard

Method Index

 o doCancel()
Performs the actions needed when the Cancel button is pressed.
 o doFinish()
Performs the actions needed when the Finish button is pressed.
 o doHelp()
Performs the actions needed when the Help button is pressed.
 o getComponentAt(int)
Gets the component for the page at the given index.
 o getPageCount()
Gets the number of pages in the Wizard.
 o getSelectedIndex()
Returns the zero-relative index of the currently selected page.
 o goNext()
Go to the next page.
 o goPrevious()
Go to the previous page.
 o setCancelEnabled(boolean)
Enables or disables the Cancel button.
 o setFinishEnabled(boolean)
Enables or disables the Finish button.
 o setHelpEnabled(boolean)
Enables or disables the Help button.
 o setNextEnabled(boolean)
Enables or disables the Next button.
 o setNextPage(Component)
Sets the page to show when goNext is called.
 o setNextPageIndex(int)
Sets the index of the page to show when goNext is called.
 o setPreviousEnabled(boolean)
Enables or disables the Previous button.
 o setPreviousPage(Component)
Sets the page to show when goPrevious is called.
 o setPreviousPageIndex(int)
Sets the index of the page to show when goPrevious is called.
 o updateButtonsState()
Sets a default status for the Previous, Next and Finish buttons.

Methods

 o doCancel
public abstract void doCancel()
Performs the actions needed when the Cancel button is pressed.

See Also:
doFinish, doHelp
 o doFinish
public abstract void doFinish()
Performs the actions needed when the Finish button is pressed.

See Also:
doCancel, doHelp
 o doHelp
public abstract void doHelp()
Performs the actions needed when the Help button is pressed.

See Also:
doFinish, doCancel
 o getComponentAt
public abstract java.awt.Component getComponentAt(int index)
Gets the component for the page at the given index.

Parameters:
index - the zero-relative page index
Returns:
returns the component associated with the page
Throws: ArrayIndexOutOfBoundsException
if the index is invalid
 o getPageCount
public abstract int getPageCount()
Gets the number of pages in the Wizard.

Returns:
the number of pages currently in the Wizard
 o getSelectedIndex
public abstract int getSelectedIndex()
Returns the zero-relative index of the currently selected page.

Returns:
the currently selected page or -1 if none are shown
 o goNext
public abstract void goNext()
Go to the next page. If a page has been selected with setNextPage it will be used. If a page index has been selected with setNextPageIndex it will be used unless a page has been specified. The chain information will be reset.

See Also:
goPrevious, setNextPage, setNextPageIndex
 o goPrevious
public abstract void goPrevious()
Go to the previous page. If a page has been selected with setPreviousPage it will be used. If a page index has been selected with setPreviousPageIndex it will be used unless a page has been specified. The chain information will be reset.

See Also:
goNext, setPreviousPage, setPreviousPageIndex
 o setCancelEnabled
public abstract void setCancelEnabled(boolean status)
Enables or disables the Cancel button.

Parameters:
status - true to enable the button
See Also:
setPreviousEnabled, setNextEnabled, setFinishEnabled, setHelpEnabled
 o setFinishEnabled
public abstract void setFinishEnabled(boolean status)
Enables or disables the Finish button.

Parameters:
status - true to enable the button
See Also:
setPreviousEnabled, setNextEnabled, setCancelEnabled, setHelpEnabled
 o setHelpEnabled
public abstract void setHelpEnabled(boolean status)
Enables or disables the Help button.

Parameters:
status - true to enable the button
See Also:
setPreviousEnabled, setNextEnabled, setFinishEnabled, setCancelEnabled
 o setNextEnabled
public abstract void setNextEnabled(boolean status)
Enables or disables the Next button.

Parameters:
status - true to enable the button
See Also:
setPreviousEnabled, setFinishEnabled, setCancelEnabled, setHelpEnabled
 o setNextPage
public abstract void setNextPage(Component comp)
Sets the page to show when goNext is called.

See Also:
setPreviousPageIndex, goNext, WizardController, SimpleWizardController
 o setNextPageIndex
public abstract void setNextPageIndex(int index)
Sets the index of the page to show when goNext is called.

Parameters:
index - the zero-relative page index
See Also:
setPreviousPageIndex, goNext, WizardController, SimpleWizardController
 o setPreviousEnabled
public abstract void setPreviousEnabled(boolean status)
Enables or disables the Previous button.

Parameters:
status - true to enable the button
See Also:
setNextEnabled, setFinishEnabled, setCancelEnabled, setHelpEnabled
 o setPreviousPage
public abstract void setPreviousPage(Component comp)
Sets the page to show when goPrevious is called.

See Also:
setNextPageIndex, goPrevious, WizardController, SimpleWizardController
 o setPreviousPageIndex
public abstract void setPreviousPageIndex(int index)
Sets the index of the page to show when goPrevious is called.

Parameters:
index - the zero-relative page index
See Also:
setNextPageIndex, goPrevious, WizardController, SimpleWizardController
 o updateButtonsState
public abstract void updateButtonsState()
Sets a default status for the Previous, Next and Finish buttons.

See Also:
setPreviousEnabled, setNextEnabled, setFinishEnabled, setCancelEnabled, setHelpEnabled

All Packages  Class Hierarchy  This Package  Previous  Next  Index